Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Oct 6, 2025

Overview

This PR improves the English quality in 9 documentation files under website/docs/en. Many paragraphs were translated from Chinese and contained unnatural phrasing that didn't match the tone of professional open-source documentation.

Changes Made

Style Improvements

  • Removed overly formal phrases: Changed "please refer to" → "refer to", removed unnecessary "just" and "please"
  • Improved preposition consistency: Changed "accessed via" → "accessed at" for consistency throughout
  • Simplified verb constructions: Changed "will automatically" → "automatically" where appropriate
  • Made instructions more direct: Replaced wordy phrases with clearer alternatives (e.g., "you can use the following method to introduce" → "you can use the following approach to integrate")
  • Enhanced readability: Removed redundant words while preserving all technical information

Files Modified

  1. config/server/open.mdx - Simplified browser configuration descriptions
  2. guide/basic/server.mdx - Improved server configuration and middleware integration sections
  3. guide/advanced/env-vars.mdx - Enhanced clarity in environment variable usage and define explanation
  4. config/source/define.mdx - Refined main description
  5. guide/start/index.mdx - Improved feature descriptions and comparisons with other tools
  6. guide/advanced/hmr.mdx - Made file watching section more concise
  7. guide/basic/static-assets.mdx - Enhanced readability of asset handling descriptions
  8. guide/faq/general.mdx - Made FAQ answers sound more natural
  9. config/dev/watch-files.mdx - Enhanced clarity throughout configuration descriptions

Examples

Before:

server.open is used to configure a set of page URLs that Rsbuild will automatically open in the browser after starting the server.

After:

server.open configures which page URLs Rsbuild should automatically open in the browser after starting the server.

Before:

By default, Rsbuild will automatically set the process.env.NODE_ENV environment variable to 'development' in development mode

After:

By default, Rsbuild sets the process.env.NODE_ENV environment variable to 'development' in development mode

Quality Assurance

  • ✅ All changes preserve original meaning and technical accuracy
  • ✅ No code examples, configuration values, or technical terms were altered
  • ✅ Changes use clear, simple language appropriate for non-native English readers
  • ✅ Documentation now matches the tone of high-quality open-source projects like React, Vue, and Vite

Stats: 9 files changed, 94 insertions(+), 94 deletions(-)

Original prompt

Improve the English docs in website/docs/en. Many paragraphs were translated from Chinese and may sound unnatural.

Rewrite sentences that don't read like authentic, professional English — without changing their meaning — so they match the tone of high-quality open-source docs.

  • IMPORTANT: Only change a sentence if it clearly improves clarity or correctness.
  • IMPORTANT: Don't alter the original meaning.
  • If you edit files in docs/en, check the same files in docs/zh to see if similar updates are needed.
  • Use clear, simple language for non-native English readers.
  • Keep reasonable technical abbreviations (e.g., dev server).
  • Use sentence case for Markdown headings.
  • Don't change more than 10 files in one PR.
  • Start PR titles with docs:.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

netlify bot commented Oct 6, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 2f4a0cd
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68e3d1aeb25c530008ee7bc0
😎 Deploy Preview https://deploy-preview-6314--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 69 (🟢 up 2 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@Copilot Copilot AI changed the title Improve the English docs in website/docs/en. Many paragraphs were translated from Chinese and may sound unnatural. Rewrite sentences that don't read like authentic, professional English — **without changing their meaning** — so they match the tone o... docs: improve English clarity in documentation files Oct 6, 2025
@Copilot Copilot AI requested a review from chenjiahan October 6, 2025 14:30
Copilot finished work on behalf of chenjiahan October 6, 2025 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants